<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2//EN">
<html>

<head>
	<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
	<title>GPAC Configuration documentation </title>
</head>

<p style="text-align: center; Font-Size: 24pt">
<br/>
<b>GPAC Configuration file documentation
<br/>GPAC Version 1.0.0</b>
</p>

<br/><br/>

<a name="Overview"></a><span style="text-decoration: underline;"><b>Overview</b></span>
<p>Applications in the GPAC framework use a configuration file common to libgpac and modules (video and audio output, compositor modules). This configuration file is called  <i>GPAC.cfg</i>. It is located:
<ul>
<li>on Windows platforms, in C:\\Users\\FOO\\AppData\\Roaming\\GPAC, or in C:\\Program Files\\GPAC.</li>
<li>on iOS platforms, in a .gpac folder in the app storage directory.</li>
<li>on Android platforms, in <i>/sdcard/osmo/</i> or, if not found there, created in <i>/data/data/com.gpac.Osmo4</i>.</li>
<li>on other platforms, in a .gpac folder in the user home directory (for ex, /home/foo/.gpac/ or /Users/foo/.gpac/).</li>
</ul>
GPAC can use different configuration profiles other than the default, check <a href="https://github.com/gpac/gpac/wiki/core_config">GPAC wiki</a>.
<br/>
The config file is structured in sections, each made of one or more keys. A section is declared as <b><i>[SectionName]</i></b>, and key is declared as <b><i>keyName</i></b>=<i>value</i>. The key value is not interpreted and always handled as ASCII text.

<p>This document describes player-specific options defined in section <a href="#General" style="text-decoration: underline;">General</a> and old DirectFB options described in section <a href="#DirectFB" style="text-decoration: underline;">DirectFB</a>.
<br/>
Check GPAC wiki for the documentation of <a href="https://github.com/gpac/gpac/wiki/core_options">libgpac core options</a> and <a href="https://github.com/gpac/gpac/wiki/core_config">filter options</a> configuration.
</p>
<br/>


<i>Note on module names</i>
<br/>Module names as given in the config file are names exported by each interface and not name of the physical library file (<i>.dll, .so, ...</i>). The physical file name can however be used to identify a module - it will then be replaced by the module name.


<br/><br/>

<a name="General"></a>
<span style="text-decoration: underline;"><b>Section "General"</b></span> <i><a href="#Overview">Back to top</a></i>
<p>
The <b>General</b> section of the config file holds player-specific options.
</p>
<b>StartupFile</b> [value: <i>filename</i>]
<p style="text-indent: 5%">
Specifies file to load upon startup of most clients (Osmo4/MP4Client). If not specified, no file is loaded.
</p>

<b>LogFile</b> [value: <i>filename</i>, <b>Android only</b>]
<p style="text-indent: 5%">
Specifies where to output GPAC's log. By default, the logs are written to stdout. Note that GPAC may be compiled without log support. This is not used by MP4Client.
</p>
<b>Logs</b> [value: <i>tool[:tool]@level:tool[:tool]@level</i>, <b>Android only</b>]
<p style="text-indent: 5%">
Specifies log level for each tool. For more information on available tools and levels, check <a href=-"https://github.com/gpac/gpac/wiki/core_logs">GPAC wiki</a>.
</p>


<b>NoMIMETypeFetch</b> [value: <i>"yes" "no"</i>]
<p style="text-indent: 5%">
Specifies whether mime type should be fetched when checking a link to a new file (currently deprecated).
</p>
<b>LastWorkingDir</b> [value: <i>string</i>]
<p style="text-indent: 5%">
Indicates the last directory from which a file was opened.
</p>
<b>iOSDocumentsDir</b> [value: <i>string</i>, <b>iOS only</b>]
<p style="text-indent: 5%">
Path to the iOS document directory for the client (automatically set upon first launch of the player).
</p>

<br/><br/>

<a name="DirectFB"></a>
<span style="text-decoration: underline;"><b>Section "DirectFB"</b></span> <i><a href="#Overview">Back to top</a></i>
<p>
The "DirectFB" section of the config file holds the configuration options for the DirectFB output module. You may also  want to check the <a href="http://directfb.org/wiki/index.php/Configuring_DirectFB">official documentation</a>.
</p>
<b>DisableAcceleration</b> [value: <i>"yes"</i> <i>"no"</i>]
<p style="text-indent: 5%">
Forces to disable hardware acceleration.</p>
<b>DisableDisplay</b> [value: <i>"yes"</i> <i>"no"</i>]
<p style="text-indent: 5%">
Specifies the DisableDisplay parameter value.</p>
<b>FlipSyncMode</b> [value: <i>"waitsync"</i> <i>"wait"</i> <i>"sync"</i> <i>"swap"</i>]
<p style="text-indent: 5%">
Specifies the flip sync mode.</p>
<b>DisableBlit</b> [value: <i>"yes"</i> <i>"no"</i>]
<p style="text-indent: 5%">
Forces to disable hardware blitting.</p>
<b>WindowMode</b> [value: <i>"X11"</i> <i>"SDL"</i>]
<p style="text-indent: 5%">
Specifies the underlying windowing library.</p>


<br/><br/>


</body>
</html>
